Get Calling Profiles
The Get Calling Profiles request retrieves a list of Calling Profiles. A calling profile is a logical container for trunks and emergency strings that are used for outbound routing and emergency calling configurations. Every calling profile has a global unique identifier. You can configure multiple calling profiles and a calling profile can have multiple trunks associated. Every PSTN number is associated with one calling profile. For failover, at least two trunks must be associated with the calling profile. All trunks will be in active-active mode and the traffic will be distributed randomly between the trunks.
At least one calling profile should be configured per region, however a calling profile for each market is not required. Every number is associated with a single calling profile. When the Calling Profile is assigned to a customer, links are created in Live Platform between the customer tenant and the SBC device. In the example below, the Calling Profile OC.CUSTOMERS.AUDIO-CODE.CO.IL is configured with two SBC devices, "oc1.customers.audio-code.co.il" and "oc2.customers.audio-code.co.il". Once updated, two new links are generated in Live Platform, one for each configured SBC device.
Calling profiles are preconfigured by AudioCodes Professional Services.
HTTP Method
GET
URI
{{baseUrl}}/api/v2/oc/callingprofileExample Response
[
{
"additionalSbcList": [],
"callingProfileId": "d12aa76a-d719-4db9-bf78-7ea8bec1d7b5",
"name": "oc1.customers.audiocodes.es",
"enviroment": null,
"region": null,
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.customers.audio-codes.es",
"trunkId": "ec76b99e-9d8a-4104-b8fe-e210e633ffa4",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "d44ec241-6fa9-40a3-b729-3e90d943c89f",
"name": "oc2.customers.audio-codes.es",
"enviroment": null,
"region": null,
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc2.customers.audio-codes.es",
"trunkId": "24d4cb9f-cc3b-40a1-b8dc-5327419a43f4",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "22f42b35-7dcc-4268-a939-8c7a0af571c7",
"name": "QA_testAudiocodesLiveCloudSP2_AC_Calling_EMEA_oc1-fmcuc",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
},
{
"offerTypeName": "Calling",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.customers.fmcuc.com",
"trunkId": "f304071f-9ce4-4a15-84c2-c1b136b3b03e",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "4b829179-da9e-4e4b-ad8a-e8340dceb72a",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_EMEA_oc2-fmcuc",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc2.customers.fmcuc.com",
"trunkId": "ee839507-4776-4ba9-8e1c-9bce40ea2b50",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "538730f7-843c-4ae6-94a9-a5e70fc144b8",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_EMEA_all-fmcuc",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.customers.fmcuc.com",
"trunkId": "f304071f-9ce4-4a15-84c2-c1b136b3b03e",
"matchingSbcList": []
},
{
"trunkFqdn": "oc2.customers.fmcuc.com",
"trunkId": "ee839507-4776-4ba9-8e1c-9bce40ea2b50",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "8d7a1410-6d5f-4169-8966-3afa97a96e29",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_EMEA_all-es",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.customers.audio-codes.es",
"trunkId": "ec76b99e-9d8a-4104-b8fe-e210e633ffa4",
"matchingSbcList": []
},
{
"trunkFqdn": "oc2.customers.audio-codes.es",
"trunkId": "24d4cb9f-cc3b-40a1-b8dc-5327419a43f4",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "e1eaa11c-4133-4de2-b3a4-43e0df9400b3",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_EMEA_oc-all-es",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.customers.audio-codes.es",
"trunkId": "ec76b99e-9d8a-4104-b8fe-e210e633ffa4",
"matchingSbcList": []
},
{
"trunkFqdn": "oc2.customers.audio-codes.es",
"trunkId": "24d4cb9f-cc3b-40a1-b8dc-5327419a43f4",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "5f3fbb3b-df9b-483d-b294-c7eb01e22aac",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_AC_EMEA_Sandbox2",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.sandbox2.audiocodes.be",
"trunkId": "c3014d3d-c787-4ae2-b008-0f53e8b1defe",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "6543d4a3-7605-4656-ae5c-889f91fc6f9d",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_AC_NOAM_sandbox3us",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.sandbox3us.audiocodes.be",
"trunkId": "fd64fa85-95ba-47d5-9284-3380692b9bae",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "540c64ef-0663-4a50-b8c3-aeca9f437d24",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_AC_FMC_NOAM_Sandbox2",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "OCMobile",
"testNumbers": [
"16282581455",
"16282581458",
"16282581459"
]
},
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.sandbox2.audiocodes.be",
"trunkId": "c3014d3d-c787-4ae2-b008-0f53e8b1defe",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "Failed"
}
},
{
"additionalSbcList": [],
"callingProfileId": "f3197662-970c-4520-82bd-a61724114258",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_EMEA_livesaas",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "qa-mgmt-sbclivesaas.customers.fmcuc.com",
"trunkId": "1f71c503-8723-40ac-a99d-66f4a2d9c1ee",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "5833f9f6-a792-4dde-a963-4097feb620f2",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_NOAM",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": [
" +16282581451",
" +16282581456",
" +16282581457"
]
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.sandbox2.audiocodes.be",
"trunkId": "c3014d3d-c787-4ae2-b008-0f53e8b1defe",
"matchingSbcList": []
}
],
"validation": {
"Calling": "Failed",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "54895471-54c2-4ced-8469-b847743320bb",
"name": "QA_testAudiocodesLiveCloudSP2_FMC_Calling_NOAM_OCM",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "OCMobile",
"testNumbers": []
},
{
"offerTypeName": "Calling",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "1bb8f08d-9932-48c5-8456-2633f366d22e",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_AC_NOAM_SB1_SP2_US",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "sbc1-sp2-us.sandbox1.audiocodes.be",
"trunkId": "342fd8ff-edce-4a42-97f0-d48ad0112525",
"matchingSbcList": [
{
"sbcId": 5,
"fqdn": "sbc1-sp2-us.sandbox1.audiocodes.be",
"ipAddress": "1.1.1.1",
"name": "Service Provider2 SBC"
}
]
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "19f5c9b5-d738-4b0d-b8a5-677f75712244",
"name": "PROD_testAudiocodesLiveCloudSP2_Calling_NOAM_SB1_Call",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc1.sandbox2.audiocodes.be",
"trunkId": "c3014d3d-c787-4ae2-b008-0f53e8b1defe",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "9ee74ae1-c9f6-4742-a19f-ef1542123269",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_EMEA_shaib-sbc",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "qa-shaib-sbc1.customers.fmcuc.com",
"trunkId": "7e0302fe-864a-48d2-b0a5-1ab2220fb402",
"matchingSbcList": []
},
{
"trunkFqdn": "qa-shaib-sbc2.customers.fmcuc.com",
"trunkId": "099cf493-f109-48ff-a745-9aa360f965e4",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "c8b5f00e-c612-4bcb-adbc-ef5b679927fe",
"name": "PROD_testAudiocodesLiveCloudSP2_AC_EMEA_1234567890",
"enviroment": null,
"region": "EMEA",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "ea335d40-5f82-48e9-933a-88001c88c976",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_NOAM_sb1",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "sbc1-sp2-us.sandbox1.audiocodes.be",
"trunkId": "342fd8ff-edce-4a42-97f0-d48ad0112525",
"matchingSbcList": [
{
"sbcId": 5,
"fqdn": "sbc1-sp2-us.sandbox1.audiocodes.be",
"ipAddress": "10.0.2.4",
"name": "Service Provider2 SBC"
}
]
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "00905c48-bd70-4532-8594-5d96340889bb",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_APAC_Softbank",
"enviroment": null,
"region": "APAC",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "OCDemoCustSBC.sandbox3.audiocodes.be",
"trunkId": "774b3417-9cc6-401f-b485-1a47dcac13b3",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "63b8e93f-34f1-4a26-9034-a8aa8f2a349f",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_APAC_SoftBYOC",
"enviroment": null,
"region": "APAC",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "OCDemoCustSBC.sandbox3.audiocodes.be",
"trunkId": "774b3417-9cc6-401f-b485-1a47dcac13b3",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "eb849194-ab69-4333-aa50-fd6c7ec22956",
"name": "QA_testAudiocodesLiveCloudSP2_Calling_AC_NOAM_Bahir",
"enviroment": null,
"region": "NOAM",
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "qa-shaib-sbc3-oc.customers.fmcuc.com",
"trunkId": "9e3dd4e6-f86f-44cf-947d-ac52011dfd45",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
}
]Responses
| ■ | 200 Success |
|
Parameters |
Type |
Description |
|||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
additionalSbcList |
The list of SBC devices that have been manually matched to calling profiles in the Live Platform database by AudioCodes Professional Services. |
||||||||||||||||
|
callingProfileId |
string |
Calling Profile Id |
|||||||||||||||
|
name |
string |
Name of the calling profile retrieved from the Operator Connect portal. |
|||||||||||||||
|
environment |
string |
Name of the environment instance:
|
|||||||||||||||
|
region |
string |
Name of the Live Platform region according to AudioCodes Data center deployment:
|
|||||||||||||||
|
carrier |
|
Name of the Service provider. |
|||||||||||||||
|
offerTypes |
list array |
|
|||||||||||||||
|
offerTypeName |
string |
|
|||||||||||||||
|
testNumbers |
string |
List of SLA Call Testing numbers:
These numbers are used for the SLA Validation tests performed by AudioCodes Professional Services on the Operator Connect portal. |
|||||||||||||||
|
emergencyDialStrings |
string |
List of emergency dial prefixes. |
|||||||||||||||
|
isEmergencyProfile |
boolean default: true |
Indicates whether an emergency profile is enabled for the Calling Profile. |
|||||||||||||||
|
emergencyProfileId |
string |
The Id of the Emergency Profile. |
|||||||||||||||
|
trunksEnrolled |
list array |
|
|||||||||||||||
|
trunkFqdn |
string |
FQDN of the SBC device that is enrolled as a Microsoft Operator Connect Calling trunk. |
|||||||||||||||
|
trunkId |
string |
Id of the SBC device that is enrolled as a Microsoft Operator Connect Calling trunk. |
|||||||||||||||
|
matchingSbcList |
list array |
Automatic matching of SBC devices enrolled as a Microsoft Operator Connect Calling trunk ('SBC From Trunks' value in the Calling Profile page in Multitenant portal) that are mapped to Calling Profiles in Operator Connect portal. During the Background sync task run, Live Platform retrieves the Calling Profiles from the Operator Connect portal and matches the FQDN of those SBC devices connected to Live Platform with those enrolled as trunks and attached to Calling Profiles (in the process performing DNS lookup to resolve the IP addresses of the devices). If a match is found, Live Platform adds the devices to this list. When uploading Operator Connect (OC) numbers, you configure only those calling profiles with an attached SBC device included in this matching list i.e. enrolled trunk (see Upload Operator Connect Numbers to Customer). |
|||||||||||||||
|
sbcId |
integer |
Id of the SBC device in the Live Platform database (see Get SBC Devices). |
|||||||||||||||
|
fqdn |
|
The FQDN of the SBC device. |
|||||||||||||||
|
ipAddress |
|
The IP address of the SBC device. |
|||||||||||||||
|
name |
|
The name of the SBC device in Live Platform. |
|||||||||||||||
|
validation |
list array |
Indicates whether SLA Integration Call testing has been performed on the Operator Connect portal. The testing verifies that the Azure Communications Gateway and Microsoft Phone System are interoperating correctly with your network. The test numbers are chosen as part of the deployment of Azure Communications Gateway or when connecting to Operator Connect or Teams Phone Mobile. For more information, see here. |
|||||||||||||||
|
Calling |
string |
Indicates whether an SLA Validation test has been run on the Operator Connect portal for phone number with Offer type 'Calling' . |
|||||||||||||||
|
AudioConferencing |
string |
Indicates whether an SLA Validation test has been run on the Operator Connect portal for phone number with Offer type 'AudioConferencing'. |
|||||||||||||||
|
OCMobile |
string |
Indicates whether an SLA Validation test has been run on the Operator Connect portal for phone number with Offer type 'OCMobile'. |